<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class INavigator</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface INavigator</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Represents a fixpoint Live Analytics/ Dynamic Drill Down in in</p>
<p class="description"><p>structured content. Represents exactly one structured  &quot;aspect&quot; of a query result, eg. &quot;size of document&quot;, &quot;author rating&quot; or a  discrete element such as &quot;author's academic degree&quot;. The intervals, or  values, for such an aspect are represented by <a href="../sde_fastsearch_result/IModifier.html">IModifier</a>s.</p><p>A navigator and its modifiers may used, along with the <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a>  interface, to modify the original query for navigation in a document base.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: INavigator.html 14 2009-08-23 04:31:36Z andreas.scheerer $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---result---INavigator.php.html">/src/sde/fastsearch/result/INavigator.php</a> (line <span class="field">40</span>)
		</p>
		
				
		<pre><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a>
   |
   --INavigator</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																																																														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#attach" title="details" class="method-name">attach</a>
											(<span class="var-type"><a href="../sde_fastsearch_result/IQueryResult.html">IQueryResult</a></span>&nbsp;<span class="var-name">$queryResult</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>
										<a href="#detach" title="details" class="method-name">detach</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getDisplayName" title="details" class="method-name">getDisplayName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getEntropy" title="details" class="method-name">getEntropy</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getFieldName" title="details" class="method-name">getFieldName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getFrequencyError" title="details" class="method-name">getFrequencyError</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getHitRatio" title="details" class="method-name">getHitRatio</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getHits" title="details" class="method-name">getHits</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getHitsUsed" title="details" class="method-name">getHitsUsed</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getMax" title="details" class="method-name">getMax</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getMean" title="details" class="method-name">getMean</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getMin" title="details" class="method-name">getMin</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IModifier.html">IModifier</a></span>
										<a href="#getModifier" title="details" class="method-name">getModifier</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getName" title="details" class="method-name">getName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getSampleCount" title="details" class="method-name">getSampleCount</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getScore" title="details" class="method-name">getScore</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getType" title="details" class="method-name">getType</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getUnit" title="details" class="method-name">getUnit</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isDetached" title="details" class="method-name">isDetached</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#modifierCount" title="details" class="method-name">modifierCount</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">Iterator</span>
										<a href="#modifierNames" title="details" class="method-name">modifierNames</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">Iterator</span>
										<a href="#modifiers" title="details" class="method-name">modifiers</a>
										()
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodattach" id="attach"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">attach</span> (line <span class="line-number">145</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Attaches this navigator to the given <a href="../sde_fastsearch_result/IQueryResult.html">IQueryResult</a></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			attach
		</span>
					(<span class="var-type"><a href="../sde_fastsearch_result/IQueryResult.html">IQueryResult</a></span>&nbsp;<span class="var-name">$queryResult</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sde_fastsearch_result/IQueryResult.html">IQueryResult</a></span>
				<span class="var-name">$queryResult</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddetach" id="detach"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">detach</span> (line <span class="line-number">152</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a new navigator identical to this navigator, but removed from  its <a href="../sde_fastsearch_result/IQueryResult.html">IQueryResult</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>
		<span class="method-name">
			detach
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDisplayName" id="getDisplayName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getDisplayName</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a human readable name for this navigiator.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getDisplayName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetEntropy" id="getEntropy"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getEntropy</span> (line <span class="line-number">51</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the entropy of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getEntropy
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetFieldName" id="getFieldName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getFieldName</span> (line <span class="line-number">57</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the name of the mod-navigator field.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getFieldName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetFrequencyError" id="getFrequencyError"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getFrequencyError</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the frequency error number.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getFrequencyError
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetHitRatio" id="getHitRatio"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getHitRatio</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the hit ratio of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getHitRatio
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetHits" id="getHits"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getHits</span> (line <span class="line-number">76</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the hits count of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getHits
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetHitsUsed" id="getHitsUsed"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getHitsUsed</span> (line <span class="line-number">82</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the hits-used count of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getHitsUsed
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetMax" id="getMax"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getMax</span> (line <span class="line-number">88</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the maximum value of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getMax
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetMean" id="getMean"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getMean</span> (line <span class="line-number">95</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the mean value of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getMean
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetMin" id="getMin"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getMin</span> (line <span class="line-number">101</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the minimum value of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getMin
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetModifier" id="getModifier"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getModifier</span> (line <span class="line-number">108</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the <a href="../sde_fastsearch_result/IModifier.html">IModifier</a> with given name $name.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IModifier.html">IModifier</a></span>
		<span class="method-name">
			getModifier
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getName</span> (line <span class="line-number">114</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the formal name of this navigator, and the &quot;aspect&quot; it models.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSampleCount" id="getSampleCount"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSampleCount</span> (line <span class="line-number">120</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the sample count of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getSampleCount
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetScore" id="getScore"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getScore</span> (line <span class="line-number">126</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the score of this navigator, as reported by Search Engine.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getScore
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetType" id="getType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getType</span> (line <span class="line-number">133</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the type of this navigator. Valid types are defined in  <a href="../sde_fastsearch_result/NavigatorType.html">NavigatorType</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getType
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetUnit" id="getUnit"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getUnit</span> (line <span class="line-number">139</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the unit of this navigator.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getUnit
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisDetached" id="isDetached"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isDetached</span> (line <span class="line-number">158</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether this navigator is detached.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isDetached
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodmodifierCount" id="modifierCount"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">modifierCount</span> (line <span class="line-number">164</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the number of modifiers.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			modifierCount
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodmodifierNames" id="modifierNames"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">modifierNames</span> (line <span class="line-number">170</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Iterates over names of the modifiers.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Iterator</span>
		<span class="method-name">
			modifierNames
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodmodifiers" id="modifiers"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">modifiers</span> (line <span class="line-number">176</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Iterates over the modifiers.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Iterator</span>
		<span class="method-name">
			modifiers
		</span>
				()
			</div>
	
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../sde_fastsearch_result/IResultObject.html#methodprepareUnset">IResultObject::prepareUnset()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:30:08 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>